﻿//  Copyright 2018 Google Inc. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

using NtCoreLib.Native.SafeHandles;

namespace NtCoreLib;

/// <summary>
/// Interface to abstract the kernel transaction manager support.
/// </summary>
public interface INtTransaction
{
    /// <summary>
    /// Get handle for the transaction.
    /// </summary>
    SafeKernelObjectHandle Handle { get; }

    /// <summary>
    /// Commit the transaction
    /// </summary>
    void Commit();

    /// <summary>
    /// Rollback the transaction
    /// </summary>
    void Rollback();

    /// <summary>
    /// Enable the transaction for anything in the current thread context.
    /// </summary>
    /// <returns>The transaction context. This should be disposed to disable the transaction.</returns>
    TransactionContext Enable();
}
